<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span><a name="line.1"></a>
<span class="sourceLineNo">002</span>/*<a name="line.2"></a>
<span class="sourceLineNo">003</span> * Copyright (C) 2014 Archie L. Cobbs. All rights reserved.<a name="line.3"></a>
<span class="sourceLineNo">004</span> *<a name="line.4"></a>
<span class="sourceLineNo">005</span> * $Id: JField.html 842 2015-03-07 18:20:42Z archie.cobbs $<a name="line.5"></a>
<span class="sourceLineNo">006</span> */<a name="line.6"></a>
<span class="sourceLineNo">007</span><a name="line.7"></a>
<span class="sourceLineNo">008</span>package org.jsimpledb.annotation;<a name="line.8"></a>
<span class="sourceLineNo">009</span><a name="line.9"></a>
<span class="sourceLineNo">010</span>import java.lang.annotation.Documented;<a name="line.10"></a>
<span class="sourceLineNo">011</span>import java.lang.annotation.ElementType;<a name="line.11"></a>
<span class="sourceLineNo">012</span>import java.lang.annotation.Retention;<a name="line.12"></a>
<span class="sourceLineNo">013</span>import java.lang.annotation.RetentionPolicy;<a name="line.13"></a>
<span class="sourceLineNo">014</span>import java.lang.annotation.Target;<a name="line.14"></a>
<span class="sourceLineNo">015</span><a name="line.15"></a>
<span class="sourceLineNo">016</span>import org.jsimpledb.core.DeleteAction;<a name="line.16"></a>
<span class="sourceLineNo">017</span><a name="line.17"></a>
<span class="sourceLineNo">018</span>/**<a name="line.18"></a>
<span class="sourceLineNo">019</span> * Java annotation for creating simple fields, including reference fields that refer to other Java model object types.<a name="line.19"></a>
<span class="sourceLineNo">020</span> *<a name="line.20"></a>
<span class="sourceLineNo">021</span> * &lt;p&gt;<a name="line.21"></a>
<span class="sourceLineNo">022</span> * This annotation is used in two scenarios:<a name="line.22"></a>
<span class="sourceLineNo">023</span> * &lt;ul&gt;<a name="line.23"></a>
<span class="sourceLineNo">024</span> *  &lt;li&gt;To describe a &lt;b&gt;simple&lt;/b&gt; database field by annotating the corresponding abstract Java bean property `getter' method&lt;/li&gt;<a name="line.24"></a>
<span class="sourceLineNo">025</span> *  &lt;li&gt;To describe the &lt;b&gt;sub-field(s)&lt;/b&gt; of a &lt;b&gt;complex&lt;/b&gt; database field (i.e., set, list, or map),<a name="line.25"></a>
<span class="sourceLineNo">026</span> *      that is, the collection element or map key and value&lt;/li&gt;<a name="line.26"></a>
<span class="sourceLineNo">027</span> * &lt;/ul&gt;<a name="line.27"></a>
<span class="sourceLineNo">028</span> *<a name="line.28"></a>
<span class="sourceLineNo">029</span> * &lt;p&gt;<a name="line.29"></a>
<span class="sourceLineNo">030</span> * Note that this annotation can be applied to superclass and interface methods to have the corresponding<a name="line.30"></a>
<span class="sourceLineNo">031</span> * field defined in all sub-types.<a name="line.31"></a>
<span class="sourceLineNo">032</span> * &lt;/p&gt;<a name="line.32"></a>
<span class="sourceLineNo">033</span> *<a name="line.33"></a>
<span class="sourceLineNo">034</span> * &lt;p&gt;<a name="line.34"></a>
<span class="sourceLineNo">035</span> * This annotation is not required when auto-generation of properties is enabled; see {@link JSimpleClass#autogenFields}.<a name="line.35"></a>
<span class="sourceLineNo">036</span> * &lt;/p&gt;<a name="line.36"></a>
<span class="sourceLineNo">037</span> *<a name="line.37"></a>
<span class="sourceLineNo">038</span> * &lt;p&gt;&lt;b&gt;Non-Reference Fields&lt;/b&gt;&lt;/p&gt;<a name="line.38"></a>
<span class="sourceLineNo">039</span> *<a name="line.39"></a>
<span class="sourceLineNo">040</span> * &lt;p&gt;<a name="line.40"></a>
<span class="sourceLineNo">041</span> * If the field is not a reference field, the property type is inferred from the type of the annotated method or,<a name="line.41"></a>
<span class="sourceLineNo">042</span> * in the case of complex sub-fields, the generic type of the collection class. The name of the property type<a name="line.42"></a>
<span class="sourceLineNo">043</span> * must be registered in the {@link org.jsimpledb.core.FieldTypeRegistry} (perhaps via {@link JFieldType &amp;#64;JFieldType}),<a name="line.43"></a>
<span class="sourceLineNo">044</span> * and the corresponding {@link org.jsimpledb.core.FieldType} is then used to encode/decode field values.<a name="line.44"></a>
<span class="sourceLineNo">045</span> * The type name may also be specified explicitly by {@link #name}.<a name="line.45"></a>
<span class="sourceLineNo">046</span> * &lt;/p&gt;<a name="line.46"></a>
<span class="sourceLineNo">047</span> *<a name="line.47"></a>
<span class="sourceLineNo">048</span> * &lt;p&gt;<a name="line.48"></a>
<span class="sourceLineNo">049</span> * Simple fields may be {@link #indexed}; see {@link org.jsimpledb.index} for information on querying indexes.<a name="line.49"></a>
<span class="sourceLineNo">050</span> * &lt;/p&gt;<a name="line.50"></a>
<span class="sourceLineNo">051</span> *<a name="line.51"></a>
<span class="sourceLineNo">052</span> * &lt;p&gt;&lt;b&gt;Reference Fields&lt;/b&gt;&lt;/p&gt;<a name="line.52"></a>
<span class="sourceLineNo">053</span> *<a name="line.53"></a>
<span class="sourceLineNo">054</span> * &lt;p&gt;<a name="line.54"></a>
<span class="sourceLineNo">055</span> * If the type of the field is (assignable to) a {@link JSimpleClass &amp;#64;JsimpleClass}-annotated Java model object type,<a name="line.55"></a>
<span class="sourceLineNo">056</span> * then the field is a reference field.<a name="line.56"></a>
<span class="sourceLineNo">057</span> * &lt;/p&gt;<a name="line.57"></a>
<span class="sourceLineNo">058</span> *<a name="line.58"></a>
<span class="sourceLineNo">059</span> * &lt;p&gt;<a name="line.59"></a>
<span class="sourceLineNo">060</span> * Reference fields have configurable behavior when the containing object or the referred-to object is deleted;<a name="line.60"></a>
<span class="sourceLineNo">061</span> * see {@link #onDelete} and {@link #cascadeDelete}.<a name="line.61"></a>
<span class="sourceLineNo">062</span> * &lt;/p&gt;<a name="line.62"></a>
<span class="sourceLineNo">063</span> *<a name="line.63"></a>
<span class="sourceLineNo">064</span> * &lt;p&gt;<a name="line.64"></a>
<span class="sourceLineNo">065</span> * Reference fields are always indexed; the value of {@link #indexed} is ignored.<a name="line.65"></a>
<span class="sourceLineNo">066</span> * &lt;/p&gt;<a name="line.66"></a>
<span class="sourceLineNo">067</span> *<a name="line.67"></a>
<span class="sourceLineNo">068</span> * &lt;p&gt;&lt;b&gt;Uniqueness Constraints&lt;/b&gt;&lt;/p&gt;<a name="line.68"></a>
<span class="sourceLineNo">069</span> *<a name="line.69"></a>
<span class="sourceLineNo">070</span> * &lt;p&gt;<a name="line.70"></a>
<span class="sourceLineNo">071</span> * Fields that are not complex sub-fields may be marked as {@link #unique} to impose a uniqueness constraint on the value.<a name="line.71"></a>
<span class="sourceLineNo">072</span> * Fields with uniqueness constraints must be indexed. Uniqueness constraints are handled at the JSimpleDB layer and function as<a name="line.72"></a>
<span class="sourceLineNo">073</span> * an implicit validation constraint. In other words, the constraint is verified when the validation queue is processed<a name="line.73"></a>
<span class="sourceLineNo">074</span> * and is affected by the transaction's configured {@link org.jsimpledb.ValidationMode}.<a name="line.74"></a>
<span class="sourceLineNo">075</span> * &lt;/p&gt;<a name="line.75"></a>
<span class="sourceLineNo">076</span> *<a name="line.76"></a>
<span class="sourceLineNo">077</span> * &lt;p&gt;<a name="line.77"></a>
<span class="sourceLineNo">078</span> * Optionally, specific field values may be marked as excluded from the uniqueness constraint via {@link #uniqueExclude}.<a name="line.78"></a>
<span class="sourceLineNo">079</span> * If so, the specified values may appear in multiple objects without violating the constraint. Because null values<a name="line.79"></a>
<span class="sourceLineNo">080</span> * are not allowed in annotations, {@link #uniqueExcludeNull} is provided to exclude the null value.<a name="line.80"></a>
<span class="sourceLineNo">081</span> * &lt;/p&gt;<a name="line.81"></a>
<span class="sourceLineNo">082</span> *<a name="line.82"></a>
<span class="sourceLineNo">083</span> * &lt;p&gt;<a name="line.83"></a>
<span class="sourceLineNo">084</span> * In {@link org.jsimpledb.ValidationMode#AUTOMATIC}, any upgraded {@link org.jsimpledb.JObject}s are automatically<a name="line.84"></a>
<span class="sourceLineNo">085</span> * added to the validation queue, so a uniqueness constraint added in a new schema version will be automatically verified<a name="line.85"></a>
<span class="sourceLineNo">086</span> * when any object is upgraded.<a name="line.86"></a>
<span class="sourceLineNo">087</span> * However, simpley adding, removing, or changing uniqueness constraints on an existing field doesn't force a schema<a name="line.87"></a>
<span class="sourceLineNo">088</span> * version change. Therefore, existing database objects that were previously valid could be in violation of a uniqueness<a name="line.88"></a>
<span class="sourceLineNo">089</span> * constraint that is added without one. To avoid this possibililty, change the schema version number as well.<a name="line.89"></a>
<span class="sourceLineNo">090</span> * &lt;/p&gt;<a name="line.90"></a>
<span class="sourceLineNo">091</span> */<a name="line.91"></a>
<span class="sourceLineNo">092</span>@Retention(RetentionPolicy.RUNTIME)<a name="line.92"></a>
<span class="sourceLineNo">093</span>@Target(ElementType.METHOD)<a name="line.93"></a>
<span class="sourceLineNo">094</span>@Documented<a name="line.94"></a>
<span class="sourceLineNo">095</span>public @interface JField {<a name="line.95"></a>
<span class="sourceLineNo">096</span><a name="line.96"></a>
<span class="sourceLineNo">097</span>    /**<a name="line.97"></a>
<span class="sourceLineNo">098</span>     * The name of this field.<a name="line.98"></a>
<span class="sourceLineNo">099</span>     *<a name="line.99"></a>
<span class="sourceLineNo">100</span>     * &lt;p&gt;<a name="line.100"></a>
<span class="sourceLineNo">101</span>     * If equal to the empty string (default value), the name is inferred from the name of the annotated Java bean getter method.<a name="line.101"></a>
<span class="sourceLineNo">102</span>     * &lt;/p&gt;<a name="line.102"></a>
<span class="sourceLineNo">103</span>     *<a name="line.103"></a>
<span class="sourceLineNo">104</span>     * &lt;p&gt;<a name="line.104"></a>
<span class="sourceLineNo">105</span>     * For sub-fields of complex fields, this property must be left unset.<a name="line.105"></a>
<span class="sourceLineNo">106</span>     * &lt;/p&gt;<a name="line.106"></a>
<span class="sourceLineNo">107</span>     *<a name="line.107"></a>
<span class="sourceLineNo">108</span>     * @return the name of the field<a name="line.108"></a>
<span class="sourceLineNo">109</span>     */<a name="line.109"></a>
<span class="sourceLineNo">110</span>    String name() default "";<a name="line.110"></a>
<span class="sourceLineNo">111</span><a name="line.111"></a>
<span class="sourceLineNo">112</span>    /**<a name="line.112"></a>
<span class="sourceLineNo">113</span>     * Optional override for the type of this field.<a name="line.113"></a>
<span class="sourceLineNo">114</span>     *<a name="line.114"></a>
<span class="sourceLineNo">115</span>     * &lt;p&gt;<a name="line.115"></a>
<span class="sourceLineNo">116</span>     * If set, this must equal the name of a type registered in the {@link org.jsimpledb.core.FieldTypeRegistry}<a name="line.116"></a>
<span class="sourceLineNo">117</span>     * associated with the {@link org.jsimpledb.core.Database} instance, and the annotated method's return type must match the<a name="line.117"></a>
<span class="sourceLineNo">118</span>     * {@link org.jsimpledb.core.FieldType}'s {@linkplain org.jsimpledb.core.FieldType#getTypeToken supported Java type}.<a name="line.118"></a>
<span class="sourceLineNo">119</span>     *<a name="line.119"></a>
<span class="sourceLineNo">120</span>     * &lt;p&gt;<a name="line.120"></a>
<span class="sourceLineNo">121</span>     * If equal to the empty string (default value), then the Java type is inferred from the return type of the getter method<a name="line.121"></a>
<span class="sourceLineNo">122</span>     * and the {@link org.jsimpledb.core.FieldType} is found via<a name="line.122"></a>
<span class="sourceLineNo">123</span>     * {@link org.jsimpledb.core.FieldTypeRegistry#getFieldType(com.google.common.reflect.TypeToken)<a name="line.123"></a>
<span class="sourceLineNo">124</span>     * FieldTypeRegistry.getFieldType()}.<a name="line.124"></a>
<span class="sourceLineNo">125</span>     * &lt;/p&gt;<a name="line.125"></a>
<span class="sourceLineNo">126</span>     *<a name="line.126"></a>
<span class="sourceLineNo">127</span>     * &lt;p&gt;<a name="line.127"></a>
<span class="sourceLineNo">128</span>     * For reference fields (i.e., methods with return value equal to a {@link JSimpleClass &amp;#64;JSimpleClass}-annotated class),<a name="line.128"></a>
<span class="sourceLineNo">129</span>     * this property must be left unset.<a name="line.129"></a>
<span class="sourceLineNo">130</span>     * &lt;/p&gt;<a name="line.130"></a>
<span class="sourceLineNo">131</span>     *<a name="line.131"></a>
<span class="sourceLineNo">132</span>     * &lt;p&gt;<a name="line.132"></a>
<span class="sourceLineNo">133</span>     * For sub-fields of complex fields, this property can be used to force a primitive sub-field type instead of a<a name="line.133"></a>
<span class="sourceLineNo">134</span>     * primitive wrapper type. In that case, the complex field will disallow null values. For example:<a name="line.134"></a>
<span class="sourceLineNo">135</span>     * &lt;pre&gt;<a name="line.135"></a>
<span class="sourceLineNo">136</span>     *  &amp;#64;JSetField(element = &amp;#64;JField(&lt;b&gt;type = "float"&lt;/b&gt;)) // nulls will be disallowed<a name="line.136"></a>
<span class="sourceLineNo">137</span>     *  public abstract List&amp;lt;&lt;b&gt;Float&lt;/b&gt;&amp;gt; getScores();<a name="line.137"></a>
<span class="sourceLineNo">138</span>     * &lt;/pre&gt;<a name="line.138"></a>
<span class="sourceLineNo">139</span>     *<a name="line.139"></a>
<span class="sourceLineNo">140</span>     * @return the name of the field's type<a name="line.140"></a>
<span class="sourceLineNo">141</span>     */<a name="line.141"></a>
<span class="sourceLineNo">142</span>    String type() default "";<a name="line.142"></a>
<span class="sourceLineNo">143</span><a name="line.143"></a>
<span class="sourceLineNo">144</span>    /**<a name="line.144"></a>
<span class="sourceLineNo">145</span>     * Storage ID for this field. Value should be positive and unique within the contained class.<a name="line.145"></a>
<span class="sourceLineNo">146</span>     * If zero, the configured {@link org.jsimpledb.StorageIdGenerator} will be consulted to auto-generate a value<a name="line.146"></a>
<span class="sourceLineNo">147</span>     * unless {@link JSimpleClass#autogenFields} is false (in which case an error occurs).<a name="line.147"></a>
<span class="sourceLineNo">148</span>     *<a name="line.148"></a>
<span class="sourceLineNo">149</span>     * @see org.jsimpledb.StorageIdGenerator#generateFieldStorageId StorageIdGenerator.generateFieldStorageId()<a name="line.149"></a>
<span class="sourceLineNo">150</span>     * @see org.jsimpledb.StorageIdGenerator#generateSetElementStorageId StorageIdGenerator.generateSetElementStorageId()<a name="line.150"></a>
<span class="sourceLineNo">151</span>     * @see org.jsimpledb.StorageIdGenerator#generateListElementStorageId StorageIdGenerator.generateListElementStorageId()<a name="line.151"></a>
<span class="sourceLineNo">152</span>     * @see org.jsimpledb.StorageIdGenerator#generateMapKeyStorageId StorageIdGenerator.generateMapKeyStorageId()<a name="line.152"></a>
<span class="sourceLineNo">153</span>     * @see org.jsimpledb.StorageIdGenerator#generateMapValueStorageId StorageIdGenerator.generateMapValueStorageId()<a name="line.153"></a>
<span class="sourceLineNo">154</span>     *<a name="line.154"></a>
<span class="sourceLineNo">155</span>     * @return the field's storage ID<a name="line.155"></a>
<span class="sourceLineNo">156</span>     */<a name="line.156"></a>
<span class="sourceLineNo">157</span>    int storageId() default 0;<a name="line.157"></a>
<span class="sourceLineNo">158</span><a name="line.158"></a>
<span class="sourceLineNo">159</span>    /**<a name="line.159"></a>
<span class="sourceLineNo">160</span>     * Whether this field is indexed or not.<a name="line.160"></a>
<span class="sourceLineNo">161</span>     *<a name="line.161"></a>
<span class="sourceLineNo">162</span>     * &lt;p&gt;<a name="line.162"></a>
<span class="sourceLineNo">163</span>     * Setting this property to true creates a simple index on this field. To have this field participate in<a name="line.163"></a>
<span class="sourceLineNo">164</span>     * a composite index on multiple fields, use {@link JSimpleClass#compositeIndexes}.<a name="line.164"></a>
<span class="sourceLineNo">165</span>     * &lt;/p&gt;<a name="line.165"></a>
<span class="sourceLineNo">166</span>     *<a name="line.166"></a>
<span class="sourceLineNo">167</span>     * &lt;p&gt;<a name="line.167"></a>
<span class="sourceLineNo">168</span>     * Note: reference fields are always indexed (for reference fields, this property is ignored).<a name="line.168"></a>
<span class="sourceLineNo">169</span>     * &lt;/p&gt;<a name="line.169"></a>
<span class="sourceLineNo">170</span>     *<a name="line.170"></a>
<span class="sourceLineNo">171</span>     * @return whether the field is indexed<a name="line.171"></a>
<span class="sourceLineNo">172</span>     */<a name="line.172"></a>
<span class="sourceLineNo">173</span>    boolean indexed() default false;<a name="line.173"></a>
<span class="sourceLineNo">174</span><a name="line.174"></a>
<span class="sourceLineNo">175</span>    /**<a name="line.175"></a>
<span class="sourceLineNo">176</span>     * For reference fields, configure the behavior when the referred-to object is<a name="line.176"></a>
<span class="sourceLineNo">177</span>     * {@linkplain org.jsimpledb.JObject#delete deleted}.<a name="line.177"></a>
<span class="sourceLineNo">178</span>     *<a name="line.178"></a>
<span class="sourceLineNo">179</span>     * &lt;p&gt;<a name="line.179"></a>
<span class="sourceLineNo">180</span>     * For non-reference fields this property must be equal to its default value.<a name="line.180"></a>
<span class="sourceLineNo">181</span>     * &lt;/p&gt;<a name="line.181"></a>
<span class="sourceLineNo">182</span>     *<a name="line.182"></a>
<span class="sourceLineNo">183</span>     * @return desired behavior when a referenced object is deleted<a name="line.183"></a>
<span class="sourceLineNo">184</span>     * @see #cascadeDelete<a name="line.184"></a>
<span class="sourceLineNo">185</span>     * @see org.jsimpledb.JObject#delete<a name="line.185"></a>
<span class="sourceLineNo">186</span>     */<a name="line.186"></a>
<span class="sourceLineNo">187</span>    DeleteAction onDelete() default DeleteAction.EXCEPTION;<a name="line.187"></a>
<span class="sourceLineNo">188</span><a name="line.188"></a>
<span class="sourceLineNo">189</span>    /**<a name="line.189"></a>
<span class="sourceLineNo">190</span>     * For reference fields, configure cascading behavior when the containing object is<a name="line.190"></a>
<span class="sourceLineNo">191</span>     * {@linkplain org.jsimpledb.JObject#delete deleted}. If set to true, the referred-to object<a name="line.191"></a>
<span class="sourceLineNo">192</span>     * is automatically deleted as well.<a name="line.192"></a>
<span class="sourceLineNo">193</span>     *<a name="line.193"></a>
<span class="sourceLineNo">194</span>     * &lt;p&gt;<a name="line.194"></a>
<span class="sourceLineNo">195</span>     * For non-reference fields this property must be equal to its default value.<a name="line.195"></a>
<span class="sourceLineNo">196</span>     * &lt;/p&gt;<a name="line.196"></a>
<span class="sourceLineNo">197</span>     *<a name="line.197"></a>
<span class="sourceLineNo">198</span>     * @return whether deletion should cascade to the referred-to object<a name="line.198"></a>
<span class="sourceLineNo">199</span>     * @see #onDelete<a name="line.199"></a>
<span class="sourceLineNo">200</span>     * @see org.jsimpledb.JObject#delete<a name="line.200"></a>
<span class="sourceLineNo">201</span>     */<a name="line.201"></a>
<span class="sourceLineNo">202</span>    boolean cascadeDelete() default false;<a name="line.202"></a>
<span class="sourceLineNo">203</span><a name="line.203"></a>
<span class="sourceLineNo">204</span>    /**<a name="line.204"></a>
<span class="sourceLineNo">205</span>     * Require this field's value to be unique among all database objects.<a name="line.205"></a>
<span class="sourceLineNo">206</span>     *<a name="line.206"></a>
<span class="sourceLineNo">207</span>     * &lt;p&gt;<a name="line.207"></a>
<span class="sourceLineNo">208</span>     * This property must be false for sub-fields of complex fields.<a name="line.208"></a>
<span class="sourceLineNo">209</span>     * &lt;/p&gt;<a name="line.209"></a>
<span class="sourceLineNo">210</span>     *<a name="line.210"></a>
<span class="sourceLineNo">211</span>     * @return whether the field's value should be unique<a name="line.211"></a>
<span class="sourceLineNo">212</span>     * @see #uniqueExclude<a name="line.212"></a>
<span class="sourceLineNo">213</span>     * @see #uniqueExcludeNull<a name="line.213"></a>
<span class="sourceLineNo">214</span>     */<a name="line.214"></a>
<span class="sourceLineNo">215</span>    boolean unique() default false;<a name="line.215"></a>
<span class="sourceLineNo">216</span><a name="line.216"></a>
<span class="sourceLineNo">217</span>    /**<a name="line.217"></a>
<span class="sourceLineNo">218</span>     * Specify field value(s) which are excluded from the uniqueness constraint.<a name="line.218"></a>
<span class="sourceLineNo">219</span>     *<a name="line.219"></a>
<span class="sourceLineNo">220</span>     * &lt;p&gt;<a name="line.220"></a>
<span class="sourceLineNo">221</span>     * The specified values must be valid {@link String} encodings of the associated field. For example:<a name="line.221"></a>
<span class="sourceLineNo">222</span>     * &lt;pre&gt;<a name="line.222"></a>
<span class="sourceLineNo">223</span>     *  &amp;#64;JField(indexed = true, unique = true, uniqueExclude = { "Infinity", "-Infinity" })<a name="line.223"></a>
<span class="sourceLineNo">224</span>     *  public abstract float getPriority();<a name="line.224"></a>
<span class="sourceLineNo">225</span>     * &lt;/pre&gt;<a name="line.225"></a>
<span class="sourceLineNo">226</span>     *<a name="line.226"></a>
<span class="sourceLineNo">227</span>     * &lt;p&gt;<a name="line.227"></a>
<span class="sourceLineNo">228</span>     * This property must be left empty when {@link #unique} is false.<a name="line.228"></a>
<span class="sourceLineNo">229</span>     * &lt;/p&gt;<a name="line.229"></a>
<span class="sourceLineNo">230</span>     *<a name="line.230"></a>
<span class="sourceLineNo">231</span>     * @return values to exclude from the uniqueness constraint<a name="line.231"></a>
<span class="sourceLineNo">232</span>     * @see #unique<a name="line.232"></a>
<span class="sourceLineNo">233</span>     * @see #uniqueExcludeNull<a name="line.233"></a>
<span class="sourceLineNo">234</span>     */<a name="line.234"></a>
<span class="sourceLineNo">235</span>    String[] uniqueExclude() default {};<a name="line.235"></a>
<span class="sourceLineNo">236</span><a name="line.236"></a>
<span class="sourceLineNo">237</span>    /**<a name="line.237"></a>
<span class="sourceLineNo">238</span>     * Specify that the null value is excluded from the uniqueness constraint.<a name="line.238"></a>
<span class="sourceLineNo">239</span>     *<a name="line.239"></a>
<span class="sourceLineNo">240</span>     * &lt;p&gt;<a name="line.240"></a>
<span class="sourceLineNo">241</span>     * This property must be left false when {@link #unique} is false or the field has primitive type.<a name="line.241"></a>
<span class="sourceLineNo">242</span>     * &lt;/p&gt;<a name="line.242"></a>
<span class="sourceLineNo">243</span>     *<a name="line.243"></a>
<span class="sourceLineNo">244</span>     * @return whether null should be excluded from the uniqueness constraint<a name="line.244"></a>
<span class="sourceLineNo">245</span>     * @see #unique<a name="line.245"></a>
<span class="sourceLineNo">246</span>     * @see #uniqueExclude<a name="line.246"></a>
<span class="sourceLineNo">247</span>     */<a name="line.247"></a>
<span class="sourceLineNo">248</span>    boolean uniqueExcludeNull() default false;<a name="line.248"></a>
<span class="sourceLineNo">249</span>}<a name="line.249"></a>
<span class="sourceLineNo">250</span><a name="line.250"></a>




























































</pre>
</div>
</body>
</html>
